
<html><head>
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<meta content="text/javascript" http-equiv="content-script-type">
<title>panel</title>
<link rel="stylesheet" type="text/css" href="candydoc/style.css">
<!--[if lt IE 7]><link rel="stylesheet" type="text/css" href="candydoc/ie56hack.css"><![endif]-->
<script language="JavaScript" src="candydoc/util.js" type="text/javascript"></script>
<script language="JavaScript" src="candydoc/tree.js" type="text/javascript"></script>
<script language="JavaScript" src="candydoc/explorer.js" type="text/javascript"></script>
</head><body>
<div id="tabarea"></div><div id="explorerclient"></div>
<div id="content"><script>explorer.initialize("panel");</script>
	<table class="content">
		<tr><td id="docbody"><h1>panel</h1><!-- Generated by Ddoc from ../modules/panel.d -->
<b>Authors:</b><br>
Jon "ylixir" Allen, ylixir@gmail.com
<br><br>
<b>License:</b><br>
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:
<br><br>

    The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.
<br><br>

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
IN THE SOFTWARE.
<br><br>


<script>explorer.outline.incSymbolLevel();</script>
<dl>
<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">PANEL* 
<span class="currsymbol">new_panel</span>
<script>explorer.outline.addDecl('new_panel');</script>

(WINDOW* <span class="funcparam">win</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Allocates a panel structure, associates it with a window, and places
it at the top of the stack.
<br><br>
<b>Returns:</b><br>
A pointer to a panel when successful and <b>null</b> when not.
<br><br>
<b>See Also:</b><br>
man panel
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">int 
<span class="currsymbol">bottom_panel</span>
<script>explorer.outline.addDecl('bottom_panel');</script>

(PANEL* <span class="funcparam">pan</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Moves panel to the bottom of the stack.
<br><br>
<b>Returns:</b><br>
<i>OK</i> when successful and <i>ERR</i> when not.
<br><br>
<b>See Also:</b><br>
man panel
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">int 
<span class="currsymbol">top_panel</span>
<script>explorer.outline.addDecl('top_panel');</script>

(PANEL* <span class="funcparam">pan</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Moves panel to the top of the stack.
<br><br>
<b>Returns:</b><br>
<i>OK</i> when successful and <i>ERR</i> when not.
<br><br>
<b>See Also:</b><br>
man panel
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">int 
<span class="currsymbol">show_panel</span>
<script>explorer.outline.addDecl('show_panel');</script>

(PANEL* <span class="funcparam">pan</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Makes a panel visible by placeing it on the top of the stack.
<br><br>
<b>Returns:</b><br>
<i>OK</i> when successful and <i>ERR</i> when not.
<br><br>
<b>See Also:</b><br>
man panel
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">void 
<span class="currsymbol">update_panels</span>
<script>explorer.outline.addDecl('update_panels');</script>

();
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Refreshes the virtual screen, but not the physical screen. Use with
doupdate instead of refresh or wrefresh.
<br><br>
<b>See Also:</b><br>
man panel
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">int 
<span class="currsymbol">hide_panel</span>
<script>explorer.outline.addDecl('hide_panel');</script>

(PANEL* <span class="funcparam">pan</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Hides a panel by removing it from the stack.
<br><br>
<b>Returns:</b><br>
<i>OK</i> when successful and <i>ERR</i> when not.
<br><br>
<b>See Also:</b><br>
man panel
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">WINDOW* 
<span class="currsymbol">panel_window</span>
<script>explorer.outline.addDecl('panel_window');</script>

(PANEL* <span class="funcparam">pan</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Get the window associated with the panel.
<br><br>
<b>Returns:</b><br>
A pointer to a panel when successful and <b>null</b> when not.
<br><br>
<b>See Also:</b><br>
man panel
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">int 
<span class="currsymbol">replace_panel</span>
<script>explorer.outline.addDecl('replace_panel');</script>

(PANEL* <span class="funcparam">pan</span>, WINDOW* <span class="funcparam">window</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Replace a panels associated <span class="funcparam">window</span> with another.
<br><br>
<b>Returns:</b><br>
<i>OK</i> when successful and <i>ERR</i> when not.
<br><br>
<b>See Also:</b><br>
man panel
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">int 
<span class="currsymbol">move_panel</span>
<script>explorer.outline.addDecl('move_panel');</script>

(PANEL* <span class="funcparam">pan</span>, int <span class="funcparam">starty</span>, int <span class="funcparam">startx</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Move a panel along the screens plane, but don't change it's z-order.
<br><br>
<b>Returns:</b><br>
<i>OK</i> when successful and <i>ERR</i> when not.
<br><br>
<b>See Also:</b><br>
man panel
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">int 
<span class="currsymbol">panel_hidden</span>
<script>explorer.outline.addDecl('panel_hidden');</script>

(PANEL* <span class="funcparam">pan</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Check and see if the panel is on the stack anywhere.
<br><br>
<b>See Also:</b><br>
man panel
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">PANEL* 
<span class="currsymbol">panel_above</span>
<script>explorer.outline.addDecl('panel_above');</script>

(PANEL* <span class="funcparam">pan</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Get the panel above the given panel on the stack.
<br><br>
<b>Returns:</b><br>
A pointer to a panel when successful and <b>null</b> when not.
<br><br>
<b>See Also:</b><br>
man panel
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">PANEL* 
<span class="currsymbol">panel_below</span>
<script>explorer.outline.addDecl('panel_below');</script>

(PANEL* <span class="funcparam">pan</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Get the panel below the given panel on the stack.
<br><br>
<b>Returns:</b><br>
A pointer to a panel when successful and <b>null</b> when not.
<br><br>
<b>See Also:</b><br>
man panel
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">int 
<span class="currsymbol">set_panel_userptr</span>
<script>explorer.outline.addDecl('set_panel_userptr');</script>

(PANEL* <span class="funcparam">pan</span>, void* <span class="funcparam">ptr</span>);
<br>void* 
<span class="currsymbol">panel_userptr</span>
<script>explorer.outline.addDecl('panel_userptr');</script>

(PANEL* <span class="funcparam">pan</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Retrieve/store the panel user pointer.
<br><br>
<b>See Also:</b><br>
man panel
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">int 
<span class="currsymbol">del_panel</span>
<script>explorer.outline.addDecl('del_panel');</script>

(PANEL* <span class="funcparam">pan</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Remove a panel from the stack and free the memory with it (but not
the associated window).
<br><br>
<b>Returns:</b><br>
<i>OK</i> when successful and <i>ERR</i> when not.
<br><br>
<b>See Also:</b><br>
man panel
<br><br>

</dd>
</dl>
<script>explorer.outline.decSymbolLevel();</script>


</td></tr>
		<tr><td id="docfooter">
			Page was generated with
			<img src="candydoc/img/candydoc.gif" style="vertical-align:middle; position:relative; top:-1px">
			on Sat Oct 25 15:39:19 2008

		</td></tr>
	</table>
</div>
<script></script>
</body></html>


